<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class FormAuthenticator</title>
			<link rel="stylesheet" href="../../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class FormAuthenticator</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
											<a href="#sec-consts">Constants</a>
						
			</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">FormAuthenticator class</p>
<p class="description"><p>An <strong>Authenticator</strong> and <strong>Valve</strong> implementation of FORM BASED  Authentication, as described in the Servlet API Specification, Version 2.2.</p></p>
		<p class="notes">
			Located in <a class="field" href="_aas---authenticator---FormAuthenticator.php.html">/aas/authenticator/FormAuthenticator.php</a> (line <span class="field">44</span>)
		</p>
		
				
		<pre><a href="../../php-aas/authenticator/AuthenticatorBase.html">AuthenticatorBase</a>
   |
   --FormAuthenticator</pre>
	
			</div>
</div>



	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
															<a href="#sec-consts">Constants</a>
							
					</div>
		<div class="info-box-body">
			<div class="var-summary">
																																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$characterEncoding" title="details" class="var-name">$characterEncoding</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$log" title="details" class="var-name">$log</a>
				</div>
											</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-consts">Constants</a>
							
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																				
												<div class="method-definition">
											<span class="method-result">FormAuthenticator</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#authenticate" title="details" class="method-name">authenticate</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>, <span class="var-type"><a href="../../php-aas/deploy/LoginConfig.html">LoginConfig</a></span>&nbsp;<span class="var-name">$config</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#getCharacterEncoding" title="details" class="method-name">getCharacterEncoding</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#matchRequest" title="details" class="method-name">matchRequest</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#restoreRequest" title="details" class="method-name">restoreRequest</a>
											(<span class="var-type">request</span>&nbsp;<span class="var-name">$request</span>, <span class="var-type">session</span>&nbsp;<span class="var-name">$session</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setCharacterEncoding" title="details" class="method-name">setCharacterEncoding</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$encoding</span>)
									</div>
								</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
												<a href="#sec-consts">Constants</a>
							
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="var$characterEncoding" id="$characterEncoding"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$characterEncoding</span>
			 = <span class="var-default"> null</span>			(line <span class="line-number">61</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Character encoding to use to read the username and password parameters  from the request. If not set, the encoding of the request body will be  used.</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$log" id="$log"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$log</span>
						(line <span class="line-number">50</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Logger</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
							<h4>Inherited Variables</h4>
				<A NAME='inherited_vars'><!-- --></A>
									<p>Inherited from <span class="classname"><a href="../../php-aas/authenticator/AuthenticatorBase.html">AuthenticatorBase</a></span></p>
					<blockquote>
													<span class="var-title">
								<span class="var-name"><a href="../../php-aas/authenticator/AuthenticatorBase.html#var$cache">AuthenticatorBase::$cache</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../../php-aas/authenticator/AuthenticatorBase.html#var$context">AuthenticatorBase::$context</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../../php-aas/authenticator/AuthenticatorBase.html#var$disableProxyCaching">AuthenticatorBase::$disableProxyCaching</a></span><br>
							</span>
											</blockquote> 
										
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
																			<a href="#sec-consts">Constants</a>
							
										<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="method__construct" id="__construct"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number">71</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Construct new Form Authenticator.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">FormAuthenticator</span>
		<span class="method-name">
			__construct
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodauthenticate" id="authenticate"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">authenticate</span> (line <span class="line-number">111</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Authenticate the user making this request, based on the specified  login configuration.  Return <div class="src-code"><ol><li><div class="src-line"><span class="src-id">true</span></div></li>
</ol></div> if any specified  constraint has been satisfied, or <div class="src-code"><ol><li><div class="src-line"><span class="src-id">false</span></div></li>
</ol></div> if we have  created a response challenge already.</p>
	<ul class="tags">
				<li><span class="field">exception:</span> IOException if an input/output error occurs</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			authenticate
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>, <span class="var-type"><a href="../../php-aas/deploy/LoginConfig.html">LoginConfig</a></span>&nbsp;<span class="var-name">$config</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">request</span>
				<span class="var-name">$request</span><span class="var-description">: Request we are processing</span>			</li>
					<li>
				<span class="var-type">response</span>
				<span class="var-name">&$response</span><span class="var-description">: Response we are creating</span>			</li>
					<li>
				<span class="var-type">config</span>
				<span class="var-name">$config</span><span class="var-description">: Login configuration describing how authentication               should be performed</span>			</li>
				</ul>
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../../php-aas/authenticator/AuthenticatorBase.html#methodauthenticate">AuthenticatorBase::authenticate()</a></dt>
						<dd>Authenticate the user making this request, based on the specified  login configuration.  Return <div class="src-code"><ol><li><div class="src-line"><span class="src-id">true</span></div></li>
</ol></div> if any specified  constraint has been satisfied, or <div class="src-code"><ol><li><div class="src-line"><span class="src-id">false</span></div></li>
</ol></div> if we have  created a response challenge already.</dd>
					</dl>
			
	</div>
<a name="methodgetCharacterEncoding" id="getCharacterEncoding"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getCharacterEncoding</span> (line <span class="line-number">82</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the character encoding to use to read the username and password.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			getCharacterEncoding
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodmatchRequest" id="matchRequest"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">matchRequest</span> (line <span class="line-number">310</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Does this request match the saved one (so that it must be the redirect  we signalled after successful authentication?</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			matchRequest
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">request</span>
				<span class="var-name">$request</span><span class="var-description">: The request to be verified</span>			</li>
				</ul>
		
			
	</div>
<a name="methodrestoreRequest" id="restoreRequest"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">restoreRequest</span> (line <span class="line-number">359</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Restore the original request from information stored in our session.</p>
<p class="description"><p>If the original request is no longer present (because the session  timed out), return <div class="src-code"><ol><li><div class="src-line"><span class="src-id">false</span></div></li>
</ol></div>; otherwise, return  <div class="src-code"><ol><li><div class="src-line"><span class="src-id">true</span></div></li>
</ol></div>.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			restoreRequest
		</span>
					(<span class="var-type">request</span>&nbsp;<span class="var-name">$request</span>, <span class="var-type">session</span>&nbsp;<span class="var-name">$session</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">request</span>
				<span class="var-name">$request</span><span class="var-description">: The request to be restored</span>			</li>
					<li>
				<span class="var-type">session</span>
				<span class="var-name">$session</span><span class="var-description">: The session containing the saved information</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetCharacterEncoding" id="setCharacterEncoding"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setCharacterEncoding</span> (line <span class="line-number">90</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the character encoding to be used to read the username and password.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setCharacterEncoding
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$encoding</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$encoding</span>			</li>
				</ul>
		
			
	</div>
							<h4>Inherited Methods</h4>
				<a name='inherited_methods'><!-- --></a>	
									<!-- =========== Summary =========== -->
					<p>Inherited From <span class="classname"><a href="../../php-aas/authenticator/AuthenticatorBase.html">AuthenticatorBase</a></span></p>
					<blockquote>
													<span class="method-name"><a href="../../php-aas/authenticator/AuthenticatorBase.html#methodaccessControl">AuthenticatorBase::accessControl()</a></span><br>
													<span class="method-name"><a href="../../php-aas/authenticator/AuthenticatorBase.html#methodauthenticate">AuthenticatorBase::authenticate()</a></span><br>
													<span class="method-name"><a href="../../php-aas/authenticator/AuthenticatorBase.html#methodfindConstraint">AuthenticatorBase::findConstraint()</a></span><br>
													<span class="method-name"><a href="../../php-aas/authenticator/AuthenticatorBase.html#methodgetCache">AuthenticatorBase::getCache()</a></span><br>
													<span class="method-name"><a href="../../php-aas/authenticator/AuthenticatorBase.html#methodgetContainer">AuthenticatorBase::getContainer()</a></span><br>
													<span class="method-name"><a href="../../php-aas/authenticator/AuthenticatorBase.html#methodgetDisableProxyCaching">AuthenticatorBase::getDisableProxyCaching()</a></span><br>
													<span class="method-name"><a href="../../php-aas/authenticator/AuthenticatorBase.html#methodinvoke">AuthenticatorBase::invoke()</a></span><br>
													<span class="method-name"><a href="../../php-aas/authenticator/AuthenticatorBase.html#methodregister">AuthenticatorBase::register()</a></span><br>
													<span class="method-name"><a href="../../php-aas/authenticator/AuthenticatorBase.html#methodsetCache">AuthenticatorBase::setCache()</a></span><br>
													<span class="method-name"><a href="../../php-aas/authenticator/AuthenticatorBase.html#methodsetContainer">AuthenticatorBase::setContainer()</a></span><br>
													<span class="method-name"><a href="../../php-aas/authenticator/AuthenticatorBase.html#methodsetDisableProxyCaching">AuthenticatorBase::setDisableProxyCaching()</a></span><br>
											</blockquote>
										
		</div>
	</div>

	<a name="sec-consts"></a>
	<div class="info-box">
		<div class="info-box-title">Class Constants</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
						
			
												<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
														| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
										<h4>Inherited Constants</h4>
				<A NAME='inherited_vars'><!-- --></A>
									<p>Inherited from <span class="classname"><a href="../../php-aas/authenticator/AuthenticatorBase.html">AuthenticatorBase</a></span></p>
					<blockquote>
													<img src="../../media/images/Variable.png" />
							<span class="const-title">
								<span class="const-name"><a href="../../php-aas/authenticator/AuthenticatorBase.html#constBASIC_METHOD">AuthenticatorBase::BASIC_METHOD</a></span><br>
							</span>
													<img src="../../media/images/Variable.png" />
							<span class="const-title">
								<span class="const-name"><a href="../../php-aas/authenticator/AuthenticatorBase.html#constCERT_METHOD">AuthenticatorBase::CERT_METHOD</a></span><br>
							</span>
													<img src="../../media/images/Variable.png" />
							<span class="const-title">
								<span class="const-name"><a href="../../php-aas/authenticator/AuthenticatorBase.html#constDIGEST_METHOD">AuthenticatorBase::DIGEST_METHOD</a></span><br>
							</span>
													<img src="../../media/images/Variable.png" />
							<span class="const-title">
								<span class="const-name"><a href="../../php-aas/authenticator/AuthenticatorBase.html#constFORM_ACTION">AuthenticatorBase::FORM_ACTION</a></span><br>
							</span>
													<img src="../../media/images/Variable.png" />
							<span class="const-title">
								<span class="const-name"><a href="../../php-aas/authenticator/AuthenticatorBase.html#constFORM_METHOD">AuthenticatorBase::FORM_METHOD</a></span><br>
							</span>
													<img src="../../media/images/Variable.png" />
							<span class="const-title">
								<span class="const-name"><a href="../../php-aas/authenticator/AuthenticatorBase.html#constFORM_PASSWORD">AuthenticatorBase::FORM_PASSWORD</a></span><br>
							</span>
													<img src="../../media/images/Variable.png" />
							<span class="const-title">
								<span class="const-name"><a href="../../php-aas/authenticator/AuthenticatorBase.html#constFORM_PRINCIPAL_NOTE">AuthenticatorBase::FORM_PRINCIPAL_NOTE</a></span><br>
							</span>
													<img src="../../media/images/Variable.png" />
							<span class="const-title">
								<span class="const-name"><a href="../../php-aas/authenticator/AuthenticatorBase.html#constFORM_REQUEST_NOTE">AuthenticatorBase::FORM_REQUEST_NOTE</a></span><br>
							</span>
													<img src="../../media/images/Variable.png" />
							<span class="const-title">
								<span class="const-name"><a href="../../php-aas/authenticator/AuthenticatorBase.html#constFORM_USERNAME">AuthenticatorBase::FORM_USERNAME</a></span><br>
							</span>
													<img src="../../media/images/Variable.png" />
							<span class="const-title">
								<span class="const-name"><a href="../../php-aas/authenticator/AuthenticatorBase.html#constSESS_PASSWORD_NOTE">AuthenticatorBase::SESS_PASSWORD_NOTE</a></span><br>
							</span>
													<img src="../../media/images/Variable.png" />
							<span class="const-title">
								<span class="const-name"><a href="../../php-aas/authenticator/AuthenticatorBase.html#constSESS_USERNAME_NOTE">AuthenticatorBase::SESS_USERNAME_NOTE</a></span><br>
							</span>
											</blockquote> 
										
		</div>
	</div>

	<p class="notes" id="credit">
		Documentation generated on Sat, 09 Feb 2008 11:57:28 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
	</p>
	</div></body>
</html>